Build packages with unbuild to improve CJS support #2310

drwpow · 2025-05-10T16:33:30Z

Changes

Unbuild is a fantastic packaging system that is the best available in my opinion. Build all our packages with it to reduce maintenance and overhead, and improve support. It’s still ESM-first, so there should be no changes to runtime, client weight, or bundlesize downstream, and only improves stability and support.

This also aligns openapi-typescript, openapi-fetch, openapi-react-query, and swr-openapi to all be built the same way.

If this causes any issues, please file an issue! Anything that crops up is fixable with the Unbuild system because it’s based on Rollup.

How to Review

Tests cover existing usecases (we often test built code)!

Checklist

Unit tests updated
docs/ updated (if necessary)
pnpm run update:examples run (only applicable for openapi-typescript)

changeset-bot · 2025-05-10T16:33:35Z

🦋 Changeset detected

Latest commit: a340c6d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
openapi-fetch	Minor
openapi-react-query	Major
openapi-typescript	Minor
swr-openapi	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

netlify · 2025-05-10T16:33:41Z

✅ Deploy Preview for openapi-ts canceled.

Name	Link
🔨 Latest commit	`a340c6d`
🔍 Latest deploy log	https://app.netlify.com/sites/openapi-ts/deploys/681fbba9dc4bc2000872e1c9

github-actions · 2025-05-10T20:01:50Z

size-limit report 📦

Path	Size
packages/openapi-fetch/dist/index.min.js	0 B (-100% 🔽)
packages/openapi-fetch/dist/index.mjs	6.7 KB (+100% 🔺)

drwpow · 2025-05-10T20:28:34Z

packages/openapi-fetch/package.json

-        "default": "./dist/index.js"
-      },
-      "require": {
-        "types": "./dist/cjs/index.d.cts",


With separate .d.cts and .d.mts declarations generated, we don’t need to declare types separately. This was a little bit of a hack from previous builds that stuck around. With unbuild’s better generation in general, TypeScript can automatically locate types.

drwpow · 2025-05-10T20:30:53Z

packages/openapi-fetch/package.json

@@ -8,19 +8,12 @@
  },
  "license": "MIT",
  "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",


"module" has never been standardized, but was just a common community convention—common enough it started to sneak into some bundle setups. All Node LTS versions and all bundlers I’m aware of now respect "exports", which means this is no longer needed.

"main" is still standard. And technically it’s superceded by exports, but we’ll just keep it around for safety. But "module" is safe to remove at this point.

drwpow · 2025-05-10T20:31:10Z

packages/openapi-fetch/package.json

@@ -8,19 +8,12 @@
  },
  "license": "MIT",
  "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",


Same for "types"—at this point TypeScript can now just locate the types due to unbuild’s careful handling

drwpow · 2025-05-10T20:35:06Z

packages/openapi-typescript/package.json

    },
+    "./*.js": "./*.mjs",


Unbuild intentionally ships .mjs so there’s no ambiguity about the .js files being ESM, and there’s no way to opt out of this behavior. While in our case we’ve been shipping ESM for a while, I still agree in general—.js files is a bit of a clusterfuck trying to sniff out package.jsons to know how to parse it.

This is encroaching on a breaking change for this library, but I’m just considering it a minor version because:

Deep imports have never had a strict guarantee they’ll be preserved perfectly

This extension rewriting should preserve .js imports as-authored

We’re still building files 1:1 to their original versions, just with .mjs extensions, so even if a setup does break it’s a mild annoyance not a show-stopper

drwpow · 2025-05-10T20:40:48Z

packages/openapi-fetch/package.json

    "test:js": "vitest run",
-    "test:ts": "tsc --noEmit",
-    "test:ts-no-strict": "tsc --noEmit -p test/no-strict-null-checks/tsconfig.json",
+    "test:exports": "pnpm run build && attw --pack .",


I really like the “are the types wrong” type tests, so added to all packages. We were also able to remove the cjs-resolves-to-esm rule 😎

drwpow · 2025-05-10T20:45:42Z

packages/openapi-react-query/.npmignore

@@ -1,4 +1,5 @@
 .turbo
+*.config.*


Ignore build.config.ts configs for unbuild in package publishing

drwpow · 2025-05-10T20:47:48Z

packages/openapi-metadata/build.config.ts

+    // Ship CommonJS-compatible bundle
+    emitCJS: true,
+    // Don’t bundle .js files together to more closely match old exports (can remove in next major)
+    output: { preserveModules: true },


openapi-metadata was already using unbuild! But adding this config just shores it up more closely with the other packages without changing output too much.

Fix dep

drwpow · 2025-05-10T21:00:03Z

Merging this not to bulldoze anyone; this is just a very unopinionated PR that is just package maintenance. The change does require a version-bump just to guard against accidental regressions, but anything that crops up is fixable/changeable.

Overall this should be a net win for everybody, improving CJS support and build quality.

* Update schema-object.ts * chore(deps): update dependency msw to v2.7.6 (openapi-ts#2287) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency @types/node to v22.15.10 (openapi-ts#2293) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency @shikijs/vitepress-twoslash to v3.4.0 (openapi-ts#2298) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency @arethetypeswrong/cli to ^0.18.0 (openapi-ts#2272) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency execa to v9.5.3 (openapi-ts#2303) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(metadata): fix thunk type detection (openapi-ts#2125) * Don't remove `null` type if a default is present. (openapi-ts#2145) * Don't remove `null` type if a default is present. * Don't remove `null` type from enums if default is present. * Don't remove `null` type if default is present (legacy) * [ci] release (openapi-ts#2307) * [ci] release * Add 2145 manually --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Drew Powers <drew@pow.rs> * chore(deps): update dependency @types/react to v18.3.21 (openapi-ts#2218) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(openapi-fetch): fix overriding baseUrl per request without overriding default baseUrl (openapi-ts#2157) * Support $ref into `paths` (openapi-ts#2185) * React query handle 204 or zero content length (openapi-ts#2235) * fix(openapi-react-query): Handle 204 or zero Content-Length header by returning data as null * fix(openapi-react-query): updated and added 204 & zero Content-Length queryFn tests * chore(openapi-react-query): Fixed linting in test * chore(deps): update dependency @arethetypeswrong/cli to v0.18.1 (openapi-ts#2306) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency msw to v2.8.2 (openapi-ts#2304) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update Speakeasy URL (openapi-ts#2302) * chore(deps): update dependency @tanstack/react-query to v5.75.7 (openapi-ts#2301) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency lint-staged to v15.5.2 (openapi-ts#2297) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * feat(swr-openapi): add custom error types to query builder (openapi-ts#2147) * chore(deps): update vitest monorepo to v3 (openapi-ts#2284) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Encode the request body if Content-Type set (openapi-ts#2096) * Improve header handling (openapi-ts#2308) * [ci] release (openapi-ts#2309) * [ci] release * Release additional packages --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Drew Powers <drew@pow.rs> * chore: update openapi-fetch test fixture (openapi-ts#2313) * Build packages with unbuild to improve CJS support (openapi-ts#2310) * [ci] release (openapi-ts#2314) * [ci] release * Fix major bump --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Drew Powers <drew@pow.rs> * Update code of conduct source (openapi-ts#2316) Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com> --------- Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Martin Paucot <contact@martin-paucot.fr> Co-authored-by: Theron Luhn <theron@luhn.com> Co-authored-by: openapi-ts-bot <openapi-ts@googlegroups.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Drew Powers <drew@pow.rs> Co-authored-by: Luis Merino <mail@luismerino.name> Co-authored-by: Duncan Beevers <duncan@dweebd.com> Co-authored-by: Wheelebin <wheelebin@users.noreply.github.com> Co-authored-by: Nolan Di Mare Sullivan <nolan.dm.sullivan@gmail.com> Co-authored-by: しゅーまい <62363188+SSlime-s@users.noreply.github.com> Co-authored-by: Olga Bulat <obulat@gmail.com> Co-authored-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>

drwpow requested a review from a team as a code owner May 10, 2025 16:33

drwpow requested a review from htunnicliff May 10, 2025 16:33

drwpow force-pushed the unbuild branch from d2b5aed to cd974c6 Compare May 10, 2025 20:00

drwpow force-pushed the unbuild branch 7 times, most recently from 4799af3 to f375ba6 Compare May 10, 2025 20:26

drwpow commented May 10, 2025

View reviewed changes

drwpow force-pushed the unbuild branch 3 times, most recently from cef463a to 5772987 Compare May 10, 2025 20:39

drwpow commented May 10, 2025

View reviewed changes

drwpow force-pushed the unbuild branch from 5772987 to 3d437ba Compare May 10, 2025 20:44

drwpow commented May 10, 2025

View reviewed changes

drwpow force-pushed the unbuild branch from 3d437ba to 77bf8e0 Compare May 10, 2025 20:46

drwpow commented May 10, 2025

View reviewed changes

Build packages with unbuild to improve CJS support

a340c6d

Fix dep

drwpow force-pushed the unbuild branch from 77bf8e0 to a340c6d Compare May 10, 2025 20:48

drwpow merged commit e66b5ce into main May 10, 2025
14 checks passed

drwpow deleted the unbuild branch May 10, 2025 21:00

openapi-ts-bot mentioned this pull request May 10, 2025

[ci] release #2314

Merged

liangskyli mentioned this pull request May 29, 2025

cjs format error in openapi-typescript@7.8.0 #2342

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Build packages with unbuild to improve CJS support #2310

Build packages with unbuild to improve CJS support #2310

Uh oh!

drwpow commented May 10, 2025

Uh oh!

changeset-bot bot commented May 10, 2025 •

edited

Loading

Uh oh!

netlify bot commented May 10, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 10, 2025 •

edited

Loading

Uh oh!

drwpow May 10, 2025

Uh oh!

drwpow May 10, 2025

Uh oh!

drwpow May 10, 2025

Uh oh!

drwpow May 10, 2025

Uh oh!

drwpow May 10, 2025

Uh oh!

drwpow May 10, 2025

Uh oh!

drwpow May 10, 2025

Uh oh!

drwpow commented May 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Build packages with unbuild to improve CJS support #2310

Build packages with unbuild to improve CJS support #2310

Uh oh!

Conversation

drwpow commented May 10, 2025

Changes

How to Review

Checklist

Uh oh!

changeset-bot bot commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

netlify bot commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for openapi-ts canceled.

Uh oh!

github-actions bot commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

drwpow May 10, 2025

Choose a reason for hiding this comment

Uh oh!

drwpow May 10, 2025

Choose a reason for hiding this comment

Uh oh!

drwpow May 10, 2025

Choose a reason for hiding this comment

Uh oh!

drwpow May 10, 2025

Choose a reason for hiding this comment

Uh oh!

drwpow May 10, 2025

Choose a reason for hiding this comment

Uh oh!

drwpow May 10, 2025

Choose a reason for hiding this comment

Uh oh!

drwpow May 10, 2025

Choose a reason for hiding this comment

Uh oh!

drwpow commented May 10, 2025

Uh oh!

Uh oh!

Uh oh!

changeset-bot bot commented May 10, 2025 •

edited

Loading

netlify bot commented May 10, 2025 •

edited

Loading

github-actions bot commented May 10, 2025 •

edited

Loading